LotusScript Doc

Class: LSAWebPageItem

Represents a web page consisting of a key for access and an url. This class can be used together with the class LSANamedList and implemets the AnyItem interface.

Version:
1.2, 21.MAR.2000
History:
nullnull



Property Summary
Public Property Set Delimiter As String
Public Property Get Delimiter As String
Public Property Get DisplayFormat As String
Public Property Set DisplayFormat As String
Public Property Get Formatted As String
Public Property Set Key As String
Public Property Get Key As String
Public Property Set NotAllowedChars As Variant
Public Property Get NotAllowedChars As Variant
Public Property Set URL As String
Public Property Get URL As String

Method Summary
Sub Clear ()
Function CompareTo (CompItem As LSAWebPageItem) As Integer
Sub Delete ()
Sub Explode (serializedObj As String)
Function hasAttributeChanged (attrName As String) As Integer
Function hasChanged () As Integer
Function Implode () As String
Function IsEmptyInstance () As Integer
Sub New (newKey As String, newURL As String)
Sub Validate ()

Property Detail

Public Property Set Key AsString

Sets the description for an web page and checks on the us of not allowed charakters e.g. "Homepage" for the homepage url of a company

Summmary Top

Public Property Get Key AsString

Summmary Top

Public Property Set URL AsString

Sets the URL of the web page and checks on not allowed chars.

Summmary Top

Public Property Get URL AsString

Summmary Top

Public Property Set Delimiter AsString

When the object is imploded to a serial data string this character will be used as seperator. If the programmer doesn't set a delimiter a default value will be delivered by the class.

Summmary Top

Public Property Get Delimiter AsString

Summmary Top

Public Property Set NotAllowedChars AsVariant

These characters are not allowed to be use in the key property

Summmary Top

Public Property Get NotAllowedChars AsVariant

Summmary Top

Public Property Get DisplayFormat AsString

The display format is a rule for formatting the object data when the property 'Formatted' is used. The values of the constants DefaultKeyName and DefaultURLName has to be used to form the format

Summmary Top

Public Property Set DisplayFormat AsString

Summmary Top

Public Property Get Formatted AsString

Formats the object's data in a user defined way

Summmary Top
Method Detail

New

Public Sub New(newKey As String,newURL As String)
Sets the properties Key and URL with the parameter values. Default values for the properties Delimiter, NotAllowedChars and DisplayFormat are set.

Parameters:
newKeyStringthe key with which the web page can be reached in a list
newURLStringthe URL address of the web page
Summmary Top

Delete

Public Sub Delete
Summmary Top

Implode

Public Function Implode As String
Writes the data of the object to a serialized data string. The string should is of the form: ~~~~, where the character "~" is the delimiter

Returns:
Stringserial data string representing the object
Summmary Top

Explode

Public Sub Explode(serializedObj As String)
Transforms a string build by the implode method in its components. The string should be in the form ~~ ~ or ~~~~, where "~" is the attribute delimiter. After explode the old values are reseted

Parameters:
serializedObjStringString of the format as delivered by the implode method
Errors:
ErrDataDoesntCorrespondToObject
Summmary Top

Validate

Public Sub Validate
The validate method checks that the properties "Key" and "URL" aren't empty.

Errors:
ErrPageNameEmpty
ErrURLEmpty
Summmary Top

Clear

Public Sub Clear
The method clears the values of the e-mail item object. After the usage of clear the method IsEmptyInstance will deliver true as return value.

Summmary Top

IsEmptyInstance

Public Function IsEmptyInstance As Integer
Checks if the attribute Key and Url are set to none empty strings ("").

Returns:
booleantrue, if attributes are empty
Summmary Top

CompareTo

Public Function CompareTo(CompItem As LSAWebPageItem) As Integer
Compares the properties Key and URL of the WebPageItem object.

Parameters:
compItemLSAWebPageItemthe object to compare against
Returns:
booleantrue, if object have same attributes
Summmary Top

hasAttributeChanged

Public Function hasAttributeChanged(attrName As String) As Integer
Checks if the attribute with the name attrName has heen changed

Parameters:
attrNameStringthe name of the attribute to check
Returns:
booleantrue, if the attribute has changed
Summmary Top

hasChanged

Public Function hasChanged As Integer
Checks one of the objects attributes has been changed

Summmary Top

TopLotusScript Doc
© Lotus Professional Services
generated on : 05-Apr-01 8:40:00 AM